home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / drawlist_ic.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  4.0 KB  |  119 lines
  1. TABLE OF CONTENTS
  2.  
  3. drawlist_ic/--datasheet--
  4. drawlist_ic/DRAWLIST_GetClass
  5. drawlist_ic/--datasheet--                           drawlist_ic/--datasheet--
  6.  
  7.     NAME
  8.         drawlist_ic -- create drawlist BOOPSI objects
  9.  
  10.     SUPERCLASS
  11.         imageclass
  12.  
  13.     REQUIRES
  14.         None.
  15.  
  16.     DESCRIPTION
  17.         This image class can create custom scaled glyphs via a
  18.         "drawlist". The drawlist is an array of drawing directives
  19.         such as lines, areafills, etc. All coordinates are based
  20.         on an imaginary grid of a user specified size, then
  21.         ScalerDiv() is used to scale these coordinates to the desired
  22.         image size to be rendered. This is a lower level class utilized
  23.         by glyph.image, if you create some interesting drawlist, please
  24.         consider passing them on to others, or to us for inclusion.
  25.  
  26.     METHODS
  27.         OM_NEW -- Create the drawlist image.  Passed to superclass, then
  28.             OM_SET.
  29.  
  30.         OM_GET -- Get object attributes.  Passed to superclass first.
  31.  
  32.         OM_SET -- Set object attributes.  Passed to superclass first.
  33.  
  34.         OM_UPDATE -- Set object notification attributes.  Passed to
  35.             superclass first.
  36.  
  37.         IM_DRAW -- Renders the images.  Overrides the superclass.
  38.         IM_DRAWFRAME -- Renders the images scaled to thee frame size.
  39.             Overrides the superclass.
  40.  
  41.         All other methods are passed to the superclass, including OM_DISPOSE.
  42.  
  43.     ATTRIBUTES
  44.         DRAWLIST_Directives (struct DrawList *)
  45.             An array of drawlist directive structures are passed
  46.             to specify the vectors and render operation. The last
  47.             entry must be DLST_END!
  48.  
  49.             struct DrawList
  50.             {
  51.                 WORD dl_Directive;
  52.                 WORD dl_X1, dl_Y1;
  53.                 WORD dl_X2, dl_Y2;
  54.                 WORD dl_Pen;
  55.             };
  56.  
  57.  
  58.             The following directives are supported;
  59.  
  60.             DLST_END      - End the directive list.
  61.             DLST_LINE     - Render a line from dl_x1,dl_y1 to dl_x2,dl_y2
  62.             DLST_RECT     - Cause a RectFill() of size dl_x1,dl_y1,dl_x2,dl_y2
  63.             DLST_LINEPAT  - Set the line pattern to value held in dl_Pen
  64.             DLST_FILLPAT  - Set the fill pattern to value held in dl_Pen
  65.             DLST_LINESIZE - Set the drawlist line thickness via dl_Pen
  66.             DLST_AMOVE    - AreaMove() using dl_x1,dl_y1
  67.             DLST_ADRAW    - AreaDraw() using dl_x1,dl_y1
  68.             DLST_AFILL    - Cause the AreaFill() operation 
  69.             DLST_FILL     - Flood() an area.
  70.             DLST_ELLIPSE  - AreaEllipse()
  71.             DLST_CIRCLE   - AreaCircle()
  72.             DLST_BEVELBOX - currently unsupported (alpha function removed)
  73.             DLST_ARC      - currently unsupported
  74.             DLST_START    - currently unsupported
  75.             DLST_BOUNDS   - currently unsupported
  76.  
  77.             Defaults to NULL.
  78.  
  79.             Applicability is (OM_NEW, OM_SET, OM_GET)
  80.  
  81.         DRAWLIST_RefHeight (WORD)
  82.             Reference height of the drawlist imagary grid.
  83.  
  84.             Applicability is (OM_NEW, OM_SET, OM_GET)
  85.  
  86.         DRAWLIST_RefWidth (WORD)
  87.             Reference width of the drawlist imagary grid.
  88.  
  89.             Applicability is (OM_NEW, OM_SET, OM_GET)
  90. drawlist_ic/DRAWLIST_GetClass                   drawlist_ic/DRAWLIST_GetClass
  91.  
  92.     NAME
  93.         DRAWLIST_GetClass -- Gets the pointer to the drawlist class.
  94.  
  95.     SYNOPSIS
  96.         drawlist_class = DRAWLIST_GetClass();
  97.         D0
  98.  
  99.         Class * DRAWLIST_GetClass(VOID);
  100.  
  101.     FUNCTION
  102.         Obtains the pointer to the DrawList image class for use with
  103.         NewObject().  This function always returns a valid pointer so
  104.         you do not need to check it.  The reason is that if the library
  105.         opens fine, then the pointer returned is already setup.  (Of course
  106.         this implies that if opening the library fails, you shouldn't be
  107.         calling this.)
  108.  
  109.         Note that this function does not create the class, that is done
  110.         when the class library is opened.
  111.  
  112.     INPUTS
  113.         Nothing.
  114.  
  115.     RESULT
  116.         drawlist_class - Pointer to the DrawList image class.
  117.  
  118.     SEE ALSO
  119.